Skip to content

docs: MkDocs site + ICA/AMICA concepts, figures, community files - #97

Merged
neuromechanist merged 5 commits into
mainfrom
docs/issue-96-mkdocs-site
Jul 11, 2026
Merged

docs: MkDocs site + ICA/AMICA concepts, figures, community files#97
neuromechanist merged 5 commits into
mainfrom
docs/issue-96-mkdocs-site

Conversation

@neuromechanist

@neuromechanist neuromechanist commented Jul 10, 2026

Copy link
Copy Markdown
Member

Closes #96.

Documentation for the JOSS-readiness track (Phase R2 in .context/plan.md): the MkDocs Material site, an intro theory section with figures, and the community-health files.

What changed

  • Site infra: mkdocs.yml (Material theme, mkdocstrings with docstring_style: numpy, git-revision-date), docs extra in pyproject.toml, .github/workflows/docs.yml (build + deploy to GitHub Pages), .gitignore for site/.
  • Core pages: Home, Getting Started (uv install + quickstart), User Guide (Backends & Devices, Validation & Parity), API Reference (AMICA / PyTorch / NumPy via mkdocstrings), Development, Changelog.
  • Background section (new): "What is ICA?", "What is AMICA?", "How AMICA works" for readers new to ICA, with real LaTeX math (MathJax via arithmatex) and 6 figures.
  • Figures (in docs/assets/figures/): ICA source->mix->unmix schematic, mixing-geometry scatter, generalized-Gaussian density family, mixture source density, AMICA algorithm-flow diagram, and a log-likelihood convergence curve from a real AMICA fit on the bundled sample EEG (final LL = -3.404, matching the Fortran-parity target).
  • Community health: CONTRIBUTING.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1), CITATION.cff (with the Palmer/Kreutz-Delgado/Makeig 2012 AMICA reference).

Verification

  • uv run mkdocs build --strict is green.
  • All figures visually checked; the two SVG schematics and four matplotlib plots pass the figures-plugin QA.

Hosting

Once the repo is at github.com/sccn/pyAMICA, its project Pages serve at the sccn org Pages custom domain subpath -> https://eeglab.org/pyAMICA/. Links are relative; stages at neuromechanist.github.io/pyAMICA/ pre-transfer.

Notes / follow-ups

Tested

uv run mkdocs build --strict (green). Docs/meta only; no runtime code touched.

@neuromechanist neuromechanist linked an issue Jul 10, 2026 that may be closed by this pull request
5 tasks
@neuromechanist neuromechanist changed the title docs: MkDocs Material site + GitHub Pages docs: MkDocs site + ICA/AMICA concepts, figures, community files Jul 10, 2026
@neuromechanist
neuromechanist merged commit 2d04107 into main Jul 11, 2026
7 checks passed
@neuromechanist
neuromechanist deleted the docs/issue-96-mkdocs-site branch July 11, 2026 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: MkDocs Material site + GitHub Pages (JOSS readiness)

1 participant